Inside Macintosh: Mac OS 8 Toolbox Reference /

Chapter 7 - Finder Interface Reference / Finder Interface Types and Constants

The Folder Descriptor Structure

NEW WITH MAC OS 8

This structure can be used to find existing folder descriptors and create new ones.

struct FolderDesc {
   size              descSize;
   FolderType        foldType;
   FolderDescFlags   flags;
   FolderClass       foldClass;
   FolderType        foldLocation;
   OSType            badgeSignature;
   OSType            badgeType;
   UInt32            reserved;
   Str63             name
};
typedef struct FolderDesc FolderDesc;
typedef FolderDesc *FolderDescPtr;

Field Description

descSize

Size (in bytes) of this structure.

foldType

A constant of type FolderType that identifies the kind of target folder desired. See "Folder Type Constants" for a list of possible folder types.

flags

Flags indicating whether a folder is created during startup, if the folder name is locked, and if the folder created is invisible; see "Folder Descriptor Flag Constants".

foldClass

The class indicating whether the folder is relative to the parent folder or special; see "Folder Descriptor Class Constants".

foldLocation

For a relative folder, the foldLocation field specifies the FolderType of the parent folder of the target. For special folders, the location of the folder. See "Folder Descriptor Location Constants".

badgeSignature

The OSType identifying the icon badge signature. Set to 0.

badgeType

The OSType identifying the icon badge type. Set to 0.

reserved

Reserved for use by system software.

name

A string specifying the name of the desired folder. For relative folders, this will be the exact name of the desired folder. For special folders, the actual target folder may have a different name than the name specified in the folder descriptor. For example, the System Folder is often given a different name, but it can still be located with FindFolder.

---

Subtopics

Folder Descriptor Flag Constants

Folder Descriptor Class Constants

Folder Descriptor Location Constants